// 版权所有2009 Go作者。保留所有权利。
// 此源代码的使用受BSD样式
// 许可证的约束，该许可证可以在许可证文件中找到。

// 此文件实现作用域及其包含的对象。

package ast

import (
	"bytes"
	"fmt"
	"go/token"
)

// 作用域维护作用域中声明为
// 的一组命名语言实体，以及指向周围（外部）
// 作用域的链接。
// 
type Scope struct {
	Outer   *Scope
	Objects map[string]*Object
}

// NewScope在外部作用域中创建一个嵌套的新作用域。
func NewScope(outer *Scope) *Scope {
	const n = 4 // 初始作用域容量
	return &Scope{outer, make(map[string]*Object, n)}
}

// 如果在作用域s中找到具有给定名称的对象，则查找返回该对象，否则返回零。外部作用域
// 被忽略。
// 
func (s *Scope) Lookup(name string) *Object {
	return s.Objects[name]
}

// Insert尝试将命名对象obj插入作用域s。
// 如果作用域已包含同名的对象alt，
// Insert保持作用域不变并返回alt。否则
// 它插入obj并返回nil。
// 
func (s *Scope) Insert(obj *Object) (alt *Object) {
	if alt = s.Objects[obj.Name]; alt == nil {
		s.Objects[obj.Name] = obj
	}
	return
}

// 调试支持
func (s *Scope) String() string {
	var buf bytes.Buffer
	fmt.Fprintf(&buf, "scope %p {", s)
	if s != nil && len(s.Objects) > 0 {
		fmt.Fprintln(&buf)
		for _, obj := range s.Objects {
			fmt.Fprintf(&buf, "\t%s %s\n", obj.Kind, obj.Name)
		}
	}
	fmt.Fprintf(&buf, "}\n")
	return buf.String()
}

// ----------------------------------------------------------------------------------------
// 对象

// 对象描述命名语言实体，如包、
// 常量、类型、变量、函数（包括方法）或标签。
// 
// 数据字段包含特定于对象的数据：
// 
// 种类数据类型数据值
// Pkg*范围包范围
// 
// 
type Object struct {
	Kind ObjKind
	Name string // 声明名称
	Decl any    // 对应字段，XxxSpec、FuncDecl、LabeledStmt、AssignStmt、Scope；或无
	Data any    // 特定于对象的数据；或nil 
	Type any    // 类型信息的占位符；may be nil 
}

// NewObj创建一个给定类型和名称的新对象。
func NewObj(kind ObjKind, name string) *Object {
	return &Object{Kind: kind, Name: name}
}

// Pos计算对象名称声明的源位置。如果计算出的位置不正确，则可能是
func (obj *Object) Pos() token.Pos {
	name := obj.Name
	switch d := obj.Decl.(type) {
	case *Field:
		for _, n := range d.Names {
			if n.Name == name {
				return n.Pos()
			}
		}
	case *ImportSpec:
		if d.Name != nil && d.Name.Name == name {
			return d.Name.Pos()
		}
		return d.Path.Pos()
	case *ValueSpec:
		for _, n := range d.Names {
			if n.Name == name {
				return n.Pos()
			}
		}
	case *TypeSpec:
		if d.Name.Name == name {
			return d.Name.Pos()
		}
	case *FuncDecl:
		if d.Name.Name == name {
			return d.Name.Pos()
		}
	case *LabeledStmt:
		if d.Label.Name == name {
			return d.Label.Pos()
		}
	case *AssignStmt:
		for _, x := range d.Lhs {
			if ident, isIdent := x.(*Ident); isIdent && ident.Name == name {
				return ident.Pos()
			}
		}
	case *Scope:
		// predeclared object-暂时不做什么
	}
	return token.NoPos
}

// ObjKind描述对象代表什么。
type ObjKind int

// 可能的对象类型列表。
const (
	Bad ObjKind = iota // 用于错误处理
	Pkg                // 包
	Con                // 常量
	Typ                // 类型
	Var                // 变量
	Fun                // 函数或方法
	Lbl                // 标签
)

var objKindStrings = [...]string{
	Bad: "bad",
	Pkg: "package",
	Con: "const",
	Typ: "type",
	Var: "var",
	Fun: "func",
	Lbl: "label",
}

func (kind ObjKind) String() string { return objKindStrings[kind] }
